Fix: Handle -U flags with spaces in build_flags #5301
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes platformio#5237 When using '-U MACRO' (with space) in build_flags, SCons' ParseFlags() splits it into two separate items in CCFLAGS: ['-U', 'MACRO']. The previous code only captured '-U' and attempted undef[2:] which resulted in an empty string. This fix iterates through CCFLAGS with an index to detect standalone '-U' flags and pairs them with the following macro name. Both formats are now supported: - '-UMACRO' (no space) - already working - '-U MACRO' (with space) - now fixed The solution is similar to how SCons handles '-D' flags with spaces.
|
|
|
Note on testing: In my initial comment on #5237, I mentioned including tests with this PR. After exploring the codebase, I noticed there aren't existing unit tests for the builder tools (specifically for I didn't want to add a new test structure without understanding your preferred testing approach for the builder module. I'm happy to add tests if you'd like - just let me know:
I manually verified the fix handles all edge cases (both |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #5237
When using
-U MACRO(with space) inbuild_flags, SCons'ParseFlags()splits it into two separate items inCCFLAGS:['-U', 'MACRO']. The previous code only captured'-U'and attemptedundef[2:]which resulted in an empty string.Changes
This PR modifies the
ProcessFlagsfunction inplatformio/builder/tools/piobuild.pyto:-Uflags-Uwith the following macro name when they're separate items-UMACRO(no space) - already working ✓-U MACRO(with space) - now fixed ✓The solution follows a similar pattern to how SCons handles
-Dflags with spaces.Testing
Verified the fix handles:
-U MACROformat with space-UMACROformat without spaceExample
Before (broken):
build_flags = -U LORA_TX_POWERResult: Only
-Ucaptured, macro name lostAfter (fixed):
build_flags = -U LORA_TX_POWERResult: Correctly passes
-U LORA_TX_POWERto gcc